Web Service BIG API
MethodgetReport
Opis
Operacja zamówienia raportu
Operacja pozwala na złożenie zamówienia i odebranie raportu BIG IM.
Report order
This operation allows you to order report from BIG InfoMonitor.
Żądanie (getReportRequest)

Komunikat żądania jest typu getReportRequest.

Element data Element testDataMarker Element customProtocol Element protocol Choice Element requestDateTime Element requestId Sequence Element getReportRequest

Przegląd

getReportRequest Typ złożony RequestMessage
Zapytanie o raport
Report inquiry
Sequence
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
Choice
protocol Typ prosty protocolEnum
Protokół
Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są opisane w osobnych schematach i specyfikacjach.
Protocol
Indication of the selected data exchange protocol to use with BIG API.
customProtocol xs:string
Dedykowany protokół
Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.
Custom protocol
Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.
testDataMarker xs:boolean
32214
33214
22214
23214
70214
71214
74214
75214
34214
35214
Znacznik danych testowych
Znacznik logiczny określający, czy komunikat zawiera dane fikcyjne przeznaczone do testów (różnego rodzaju) czy rzeczywiste dane. Pole to zmniejsza ryzyko pomyłkowego wprowadzeniem do systemu produkcyjnego danych przekazanych w celach testowych (np. w sytuacji zmian w oprogramowaniu u subskrybentów). Dane z przypisaną wartością logiczną "prawda" nie zostaną wprowadzone do systemu produkcyjnego BIG InfoMonitor.
Test data marker
Logical value that specifies whether the message contains fictitious data intended for testing or actual data. This field reduces the risk of introduction test data to the production system. Data with a "true" logical value assigned will not be accepted by production system.
data xs:string
Dane żądania
Dane przesyłane w ramach żądania do SIBIG. Muszą być zgodne ze specyfikacją wybranego protokołu (@RequestMessage/protocol).
Request data
Data submitted as a request to SIBIG. They must conform to the specification of the selected protocol (@RequestMessage/protocol).
Odpowiedź (getReportResponse)

Komunikat odpowiedzi jest typu getReportResponse.

Element data Element customProtocol Element protocol Choice Element user Element requestDateTime Element requestId Element responseDateTime Element responseId Sequence Element getReportResponse

Przegląd

getReportResponse Typ złożony ResponseMessage
Rezultat przetworzenia zapytania o raport
Report inquiry response
Sequence
responseId Typ prosty messageId
Identyfikator odpowiedzi
Ciąg znaków jednoznacznie identyfikujący odpowiedź z systemu SIBIG. Nadawany przez BIG IM.
Response id
String uniquely identifying the response. Given by the BIG IM.
responseDateTime xs:dateTime
Data i czas przesłania odpowiedzi
Response date and time
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania, z którym związana jest ta odpowiedź. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
user xs:string
Identyfikator użytkownika
Identyfikator użytkownika przesyłającego żądanie w rejestrze BIG IM.
Username
ID of the SIBIG user submitting the request.
Choice
protocol Typ prosty protocolEnum
Protokół
Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są wyspecyfikowane w osobnych schematach i dokumentacjach.
Protocol
Indication of the selected data exchange protocol to use with BIG API.
customProtocol xs:string
Dedykowany protokół
Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.
Custom protocol
Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.
data xs:string
Dane odpowiedzi
Dane przesyłane w ramach odpowiedzi z SIBIG. Są zgodne ze specyfikacją wskazanego protokołu (@ResponseMessage/protocol).
Response data
Data submitted as a response of SIBIG. They conform to the specification of the selected protocol (@RequestMessage/protocol).
Wyjątki
WyjątekOpis
Wyjątek powoduje zwrócenie komunikatu typu http://api.big.pl/bigApi/v1:processingError.  
Wyjątek powoduje zwrócenie komunikatu typu http://api.big.pl/bigApi/v1:signInError.  
Zobacz także